/*
 * Copyright 2009 Original Author(s)
 * 
 * This file is part of Kommando
 * 
 * Kommando is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Kommando is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Kommando.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.kommando.core.search;

import java.awt.Dimension;

import javax.swing.Icon;

import org.kommando.core.Displayable;

/**
 * @author Peter De Bruycker
 */
public interface Result<T extends Displayable> extends Displayable {
    /**
     * Returns the html formatted tooltip text to be used in the gui.
     * 
     * @return the tooltip text
     */
    String getToolTip();

    T getValue();

    Icon getIcon(Dimension size);

    /**
     * Returns the html formatted name that can be used in the gui.
     * 
     * @return the formatted name
     */
    String getHtmlFormattedName();
}
